package org.dbstar.scheduler.serializer;

/*
 * Copyright 2002-2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * A strategy interface for streaming an object to an OutputStream.
 * 
 * @author Gary Russell
 * @author Mark Fisher
 * @since 3.0.5
 */
public interface Serializer<T> {

	/**
	 * Write an object of type T to the given OutputStream.
	 * <p>
	 * Note: Implementations should not close the given OutputStream (or any decorators of that OutputStream) but rather
	 * leave this up to the caller.
	 * 
	 * @param object the object to serialize
	 * @param outputStream the output stream
	 * @param close if true then close the stream after write object.
	 * @throws IOException in case of errors writing to the stream
	 */
	void serialize(T object, OutputStream outputStream, boolean close) throws IOException;

	/**
	 * Read (assemble) an object of type T from the given InputStream.
	 * <p>
	 * Note: Implementations should not close the given InputStream (or any decorators of that InputStream) but rather
	 * leave this up to the caller.
	 * 
	 * @param inputStream the input stream
	 * @param close if true then close the stream after read object.
	 * @return the deserialized object
	 * @throws IOException in case of errors reading from the stream
	 */
	T deserialize(InputStream inputStream, boolean close) throws IOException;
}
